Rename Presences to Users #616
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## main #616 +/- ##
=======================================
Coverage 50.23% 50.23%
=======================================
Files 69 69
Lines 7305 7305
=======================================
Hits 3670 3670
Misses 3145 3145
Partials 490 490
|
|
I think the term "getUsers" isn't the best choice, considering that a single user might be using multiple clients. Additionally, the SDK hasn't introduced the concept of a user just yet. Will Presence be confused? |
|
@hackerwins I think that presence |
2 tasks
hackerwins
force-pushed
the
main
branch
3 times, most recently
from
7892142
to
fdc2e1c
Compare
|
I will close this PR for now. Please let me know when you proceed. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
Rename
doc.getPresences()todoc.getUsers()as the returned value aligns more closely with user information, making this name easier to comprehend.The reason
usersis used ingetUsersis that usingclients(as yorkie Client) might imply that it should hold all information about the yorkie client. However, users only contain clientID and presence information, so I used the termusersinstead ofclients.Which issue(s) this PR fixes:
Related #609
yorkie-team/yorkie-js-sdk#618
Special notes for your reviewer:
Does this PR introduce a user-facing change?:
Additional documentation:
Checklist: